/*
Copyright (c) 2009, Young Digital Planet SA
All rights reserved.

* Redistribution and use in source and binary forms, with or without 
  modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this 
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, 
  this list of conditions and the following disclaimer in the documentation 
  and/or other materials provided with the distribution.
* Neither the name of the Young Digital Planet SA nor the names of its 
  contributors may be used to endorse or promote products derived from this 
  software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
*/
package com.yauthor.module
{
	import com.yauthor.utils.IPathBase;
	
	/**
	 * A context for operation loading. Holds data and provides
	 * some functionality that may need loading a module.
	 * @see pl.ydp.p2.ILoadable
	 */
	public interface IXMLLoadContext
	{
		/**
		 * An XML node from which a module should load its data.
		 */
		function get node():XML;
		/**
		 * Loads another object from a given node. Loader looks 
		 * for a mapping node -> object class in register. Instantiates
		 * such a class and calls its loadFromDOM.
		 * @param node a node to load an object from
		 * @return loaded object (may not implement ILoadable) or null
		 * if loader cannot find the class that is mapped to this node.
		 */
		function loadObject( node:XML ):*;
		/**
		 * Loads content of an object created earlier. This function can be used
		 * if a class is known in advance (or cannot be determined from a node).
		 * @param object an object that should load its contents.
		 * @param node a node to load object content from
		 * @return passed object paramter
		 */
		function loadContent(object:ILoadable, node:XML):ILoadable;
		/**
		 * Create a new context from a given node.
		 * @param node an XML node to create a context from.
		 * @return new context (a node attribute of a new context is
		 * a given parameter node)
		 */
		function getContextForElement(node:XML):IXMLLoadContext;
		/**
		 * A base path of a document with data. It is provided to allow
		 * modules to resolve paths.
		 */
		function get pathBase():IPathBase;
	}
}